Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add option to delete stop #25984

Merged

Conversation

Nikhil-Vats
Copy link
Contributor

@Nikhil-Vats Nikhil-Vats commented Aug 26, 2023

Details

Adds the option to delete a stop using three dots menu with confirmation modal.

Fixed Issues

$ #25901
PROPOSAL: #25901 (comment)

Tests

  1. Go to request money.
  2. Go to the distance tab.
  3. Click on add stop.
  4. Click on three dots icon.
  5. Verify that you see the option Delete stop there. Click on it.
  6. Verify that you see the confirmation modal. Click on delete.
  7. Verify that you are navgated back to previous screen with distance tab and the stop is deleted from the list of waypoints/stop.
  • Verify that no errors appear in the JS console

Offline tests

Same as above.

QA Steps

Same as above.

  • Verify that no errors appear in the JS console

PR Author Checklist

  • I linked the correct issue in the ### Fixed Issues section above
  • I wrote clear testing steps that cover the changes made in this PR
    • I added steps for local testing in the Tests section
    • I added steps for the expected offline behavior in the Offline steps section
    • I added steps for Staging and/or Production testing in the QA steps section
    • I added steps to cover failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
    • I tested this PR with a High Traffic account against the staging or production API to ensure there are no regressions (e.g. long loading states that impact usability).
  • I included screenshots or videos for tests on all platforms
  • I ran the tests on all platforms & verified they passed on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • I verified there are no console errors (if there's a console error not related to the PR, report it or open an issue for it to be fixed)
  • I followed proper code patterns (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick)
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
      • If any non-english text was added/modified, I verified the translation was requested/reviewed in #expensify-open-source and it was approved by an internal Expensify engineer. Link to Slack message:
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I followed the guidelines as stated in the Review Guidelines
  • I tested other components that can be impacted by my changes (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar are working as expected)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • I verified that if a function's arguments changed that all usages have also been updated correctly
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • If we are not using the full Onyx data that we loaded, I've added the proper selector in order to ensure the component only re-renders when the data it is using changes
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG))
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR author checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
25984_web.mp4
25984_web_offline.mp4
Mobile Web - Chrome
25984_mweb_chrome.mp4
Mobile Web - Safari
25984_mweb_safari.mp4
Desktop
25984_desktop.mp4
iOS
25984_ios.mp4
Android
25984_android.mp4

@Nikhil-Vats Nikhil-Vats requested a review from a team as a code owner August 26, 2023 00:34
@melvin-bot melvin-bot bot requested review from allroundexperts and removed request for a team August 26, 2023 00:34
@melvin-bot
Copy link

melvin-bot bot commented Aug 26, 2023

@allroundexperts Please copy/paste the Reviewer Checklist from here into a new comment on this PR and complete it. If you have the K2 extension, you can simply click: [this button]

@Nikhil-Vats
Copy link
Contributor Author

Nikhil-Vats commented Aug 26, 2023

Hey @hayata-suenaga @allroundexperts, the PR is open but I need to confirm the following scenarios before adding test proofs -

  1. The text used -
    a. I added Delete stop for three dots menu item text.
    b. Delete stop (same as above) for the title of confirmation modal.
    c. Are you sure you want to delete this stop? for confirmation message/prompt in the modal.

Are these okay or should any of these use waypoint rather than stop? If so, I will request the spanish translations for these on slack.

  1. The behaviour of this feature for start and finish points -

    function removeWaypoint(transactionID, currentIndex) {
    // Index comes from the route params and is a string
    const index = Number(currentIndex);
    const transaction = lodashGet(allTransactions, transactionID, {});
    const existingWaypoints = lodashGet(transaction, 'comment.waypoints', {});
    const totalWaypoints = _.size(existingWaypoints);
    // Prevents removing the starting or ending waypoint but clear the stored address only if there are only two waypoints
    if (totalWaypoints === 2 && (index === 0 || index === totalWaypoints - 1)) {
    saveWaypoint(transactionID, index, null);
    return;
    }

    Should the button be visible for start and finish point? I don't think it is a good idea because if start or finish is empty, it won't do anything. If they are filled, it will only clear the point rather than delete (which might be confusing).

@Nikhil-Vats
Copy link
Contributor Author

Regarding point 2, if we allow deleting start/finish points, at the moment -

  1. removeWaypoint clears the point if there are only 2 points - start and delete.
  2. BUT if there is another stop added then start/finish are actually deleted and the point adjacent becomes the new start/delete.
finish_delete.mp4
finish_point_delete.mp4

@allroundexperts
Copy link
Contributor

allroundexperts commented Aug 26, 2023

Reviewer Checklist

  • I have verified the author checklist is complete (all boxes are checked off).
  • I verified the correct issue is linked in the ### Fixed Issues section above
  • I verified testing steps are clear and they cover the changes made in this PR
    • I verified the steps for local testing are in the Tests section
    • I verified the steps for Staging and/or Production testing are in the QA steps section
    • I verified the steps cover any possible failure scenarios (i.e. verify an input displays the correct error message if the entered data is not correct)
    • I turned off my network connection and tested it while offline to ensure it matches the expected behavior (i.e. verify the default avatar icon is displayed if app is offline)
  • I checked that screenshots or videos are included for tests on all platforms
  • I included screenshots or videos for tests on all platforms
  • I verified tests pass on all platforms & I tested again on:
    • Android / native
    • Android / Chrome
    • iOS / native
    • iOS / Safari
    • MacOS / Chrome / Safari
    • MacOS / Desktop
  • If there are any errors in the console that are unrelated to this PR, I either fixed them (preferred) or linked to where I reported them in Slack
  • I verified proper code patterns were followed (see Reviewing the code)
    • I verified that any callback methods that were added or modified are named for what the method does and never what callback they handle (i.e. toggleReport and not onIconClick).
    • I verified that the left part of a conditional rendering a React component is a boolean and NOT a string, e.g. myBool && <MyComponent />.
    • I verified that comments were added to code that is not self explanatory
    • I verified that any new or modified comments were clear, correct English, and explained "why" the code was doing something instead of only explaining "what" the code was doing.
    • I verified any copy / text shown in the product is localized by adding it to src/languages/* files and using the translation method
    • I verified all numbers, amounts, dates and phone numbers shown in the product are using the localization methods
    • I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.
    • I verified proper file naming conventions were followed for any new files or renamed files. All non-platform specific files are named after what they export and are not named "index.js". All platform-specific files are named for the platform the code supports as outlined in the README.
    • I verified the JSDocs style guidelines (in STYLE.md) were followed
  • If a new code pattern is added I verified it was agreed to be used by multiple Expensify engineers
  • I verified that this PR follows the guidelines as stated in the Review Guidelines
  • I verified other components that can be impacted by these changes have been tested, and I retested again (i.e. if the PR modifies a shared library or component like Avatar, I verified the components using Avatar have been tested & I retested again)
  • I verified all code is DRY (the PR doesn't include any logic written more than once, with the exception of tests)
  • I verified any variables that can be defined as constants (ie. in CONST.js or at the top of the file that uses the constant) are defined as such
  • If a new component is created I verified that:
    • A similar component doesn't exist in the codebase
    • All props are defined accurately and each prop has a /** comment above it */
    • The file is named correctly
    • The component has a clear name that is non-ambiguous and the purpose of the component can be inferred from the name alone
    • The only data being stored in the state is data necessary for rendering and nothing else
    • For Class Components, any internal methods passed to components event handlers are bound to this properly so there are no scoping issues (i.e. for onClick={this.submit} the method this.submit should be bound to this in the constructor)
    • Any internal methods bound to this are necessary to be bound (i.e. avoid this.submit = this.submit.bind(this); if this.submit is never passed to a component event handler like onClick)
    • All JSX used for rendering exists in the render method
    • The component has the minimum amount of code necessary for its purpose, and it is broken down into smaller components in order to separate concerns and functions
  • If any new file was added I verified that:
    • The file has a description of what it does and/or why is needed at the top of the file if the code is not self explanatory
  • If a new CSS style is added I verified that:
    • A similar style doesn't already exist
    • The style can't be created with an existing StyleUtils function (i.e. StyleUtils.getBackgroundAndBorderStyle(themeColors.componentBG)
  • If the PR modifies code that runs when editing or sending messages, I tested and verified there is no unexpected behavior for all supported markdown - URLs, single line code, code blocks, quotes, headings, bold, strikethrough, and italic.
  • If the PR modifies a generic component, I tested and verified that those changes do not break usages of that component in the rest of the App (i.e. if a shared library or component like Avatar is modified, I verified that Avatar is working as expected in all cases)
  • If the PR modifies a component related to any of the existing Storybook stories, I tested and verified all stories for that component are still working as expected.
  • If the PR modifies a component or page that can be accessed by a direct deeplink, I verified that the code functions as expected when the deeplink is used - from a logged in and logged out account.
  • If a new page is added, I verified it's using the ScrollView component to make it scrollable when more elements are added to the page.
  • If the main branch was merged into this PR after a review, I tested again and verified the outcome was still expected according to the Test steps.
  • I have checked off every checkbox in the PR reviewer checklist, including those that don't apply to this PR.

Screenshots/Videos

Web
screen-recording-2023-08-28-at-33258-pm_ZcA0USoo.mp4
Mobile Web - Chrome
Screen.Recording.2023-08-28.at.3.38.10.PM.mov
Mobile Web - Safari
Screen.Recording.2023-08-28.at.3.43.11.PM.mov
Desktop
Screen.Recording.2023-08-28.at.3.39.35.PM.mov
iOS
Screen.Recording.2023-08-28.at.3.41.32.PM.mov
Android
Screen.Recording.2023-08-28.at.3.35.51.PM.mov

@allroundexperts
Copy link
Contributor

Bump on these questions @hayata-suenaga!

@hayata-suenaga
Copy link
Contributor

hayata-suenaga commented Aug 26, 2023

@Nikhil-Vats sorry for the late response 🙇

The text used -

Let's use waypoint instead of stop. Please request Spanish translations for these 🙇

The behaviour of this feature for start and finish points -

When there are only two waypoints (start and finish), let's hide the three dot button

When there are several waypoints, even start or finish waypoints can be deleted. My only concern is that we're doing some weird stuff with how we store waypoints (I think waypoints are stored in an object with each key being waypoint0 or waypoint1...

@Nikhil-Vats
Copy link
Contributor Author

Hey @hayata-suenaga @allroundexperts, I have requested for spanish translations on slack -

I verified any copy / text that was added to the app is grammatically correct in English. It adheres to proper capitalization guidelines (note: only the first word of header/labels should be capitalized), and is approved by marketing by adding the Waiting for Copy label for a copy review on the original GH to get the correct copy.

Can we also add the Waiting for Copy label on original GH right now or do we need to do it later?

I have also pushed the latest code to hide the three dots menu when there are only 2 points (start and finish). Regarding the concern of how we are storing, I will check on that right now and continue to test it and upload test proofs in a few hours.

@Nikhil-Vats
Copy link
Contributor Author

@allroundexperts I have noticed one bug on main while testing which is that the confirm modal doesn't open when we first click delete workspace, it opens second time but then third time it doesn't open. This doesn't happen on staging so it is from a recent PR and it is also affecting our delete waypoint testing on mobile browsers.

This test video is from main without our changes so we know it is not from this PR. I will create a separate issue for this on slack.

Screen.Recording.2023-08-27.at.3.00.32.AM.mov

@allroundexperts
Copy link
Contributor

@Nikhil-Vats Can you please report this (if it hasn't been reported previously) and post a link for the report here? As long as its present on main, it shouldn't block this PR.

@hayata-suenaga
Copy link
Contributor

Can we also add the Waiting for Copy label on original GH right now or do we need to do it later?

thank you for your attention to the guideline. I really appreciate it. In this case, because the change is very simple, I don't think we need marketing approval for this. But we still need Spanish translation confirmation.

This doesn't happen on staging so it is from a recent PR and it is also affecting our delete waypoint testing on mobile browsers.

so currently, when you first click the dot menu on the Waypoint Editor page, the menu popup doesn't appear?

@Nikhil-Vats
Copy link
Contributor Author

@hayata-suenaga the menu pop up will appear but when we click Delete waypoint it won't show the confirmation modal. When we do it second time then it will show. This is happening for other confirmation modals as well.

This is only happening on mobile browsers, not on desktop. I will check for mobile apps.

@Nikhil-Vats
Copy link
Contributor Author

@hayata-suenaga one more question, should we wait for Spanish translation to add test proofs and merge PR?

Or can we add test proofs and merge this PR and I can create a follow up PR as soon as we get Spanish translation?

@hayata-suenaga
Copy link
Contributor

should we wait for Spanish translation to add test proofs and merge PR?

you can record the screen or take screenshots before Spanish translation is approved. We should probably wait for Spanish translation before merging though

but again, we can do all the testing before Spanish

@hayata-suenaga
Copy link
Contributor

Can you please report this (if it hasn't been reported previously) and post a link for the report here?

@Nikhil-Vats by the way, did you have time to report the bug? (if you can find the PR that caused the regression, that's 💯

@Nikhil-Vats
Copy link
Contributor Author

I will report the bug right now and try to find the root cause today.

@Nikhil-Vats
Copy link
Contributor Author

@allroundexperts @hayata-suenaga Bug report added here.

@allroundexperts
Copy link
Contributor

@Nikhil-Vats Before working on that, can you please add the screen recordings so I can test as well.

@Nikhil-Vats
Copy link
Contributor Author

Sure @allroundexperts , on it.

@Nikhil-Vats
Copy link
Contributor Author

Hey @hayata-suenaga @allroundexperts, all test proofs added and checklist completed.

I noticed on further testing that not just the confirmation modal, many menus, pages don't open on first click. For ex - Notice the behaviour of clicking 'Request money' in the video below, it never works first time and always works the second time. So this problem is not just with the confirmation modal. This happens on mobile apps and mobile browsers.

This video is from main which you can verify because there is no option to delete the waypoints even when there are more than 2 points.

click_bug.mp4

@Nikhil-Vats
Copy link
Contributor Author

@allroundexperts Now, I will work to find out which PR caused this because this will become a major deploy blocker since it affects everything mobile and a lot of menu/pages possibly.

Also, you will notice in iOS native test video that the delete confirmation modal doesn't open at all. I tried multiple times it is the same behaviour but this is also because of the aforementioned bug and not this PR because you can try on main with delete workspace and there also the confirmation modal will never open.

@Nikhil-Vats
Copy link
Contributor Author

Nikhil-Vats commented Aug 27, 2023

@allroundexperts @hayata-suenaga Found the PR. The issue is already identified as it is affecting multiple flows - #25998.

There was only 1 change, BaseModal was changed to functional component, when I revert it everything works as expected.

@Nikhil-Vats
Copy link
Contributor Author

I noticed one more CSS issue on android browser where it is difficult to click the finish point when there are more than 2 points. @hayata-suenaga you can check the test proof for chrome mobile to see it. Should I create a separate bug report for it?

@allroundexperts
Copy link
Contributor

I noticed one more CSS issue on android browser where it is difficult to click the finish point when there are more than 2 points. @hayata-suenaga you can check the test proof for chrome mobile to see it. Should I create a separate bug report for it?

@hayata-suenaga I think I already reported the same issue here as well. Let's create a bug ticket for that as well!

@Nikhil-Vats
Copy link
Contributor Author

Hey @hayata-suenaga, I have fixed the merge conflict. Since so many people are working on this file, can we merge it quickly otherwise I am afraid we will keep running into conflicts.

I have tested the feature locally and the other feature which it had conflicts with and both work fine. And, the conflicts were simple so we didn't touch the code of the other feature.

Also, lint is failing on this PR but it is passing locally. and the reason for failing lint in this PR is because there was a prop added in the other PR which was not added in propTypes so it is not related to this PR.

@Nikhil-Vats
Copy link
Contributor Author

I have added a comment on the other PR.

@hayata-suenaga
Copy link
Contributor

Also, lint is failing on this PR but it is passing locally. and the reason for failing lint in this PR is because there was a prop added in the other PR which was not added in propTypes so it is not related to this PR.

So the lint is failing on main?

@hayata-suenaga hayata-suenaga merged commit 7b5319e into Expensify:main Aug 28, 2023
13 of 14 checks passed
@melvin-bot melvin-bot bot added the Emergency label Aug 28, 2023
@melvin-bot
Copy link

melvin-bot bot commented Aug 28, 2023

@hayata-suenaga looks like this was merged without a test passing. Please add a note explaining why this was done and remove the Emergency label if this is not an emergency.

@hayata-suenaga
Copy link
Contributor

As per this comment, we're merging the PR without lint test succeeding.

@Nikhil-Vats are you suggesting that this PR caused the lint error?

@Nikhil-Vats
Copy link
Contributor Author

Yes @hayata-suenaga , I have put a comment on that PR so that the authors can confirm.

@hayata-suenaga
Copy link
Contributor

I didn't see your coment @Nikhil-Vats can you link it?

now I'm afraid that the lint error will fail tests on main 😨

@allroundexperts
Copy link
Contributor

@hayata-suenaga I've commented here

@allroundexperts
Copy link
Contributor

I can create a quick fix PR for the lint failure if this is super urgent.

@hayata-suenaga
Copy link
Contributor

@allroundexperts yep let's open a PR

@allroundexperts
Copy link
Contributor

Sure thing. Creating now.

@allroundexperts
Copy link
Contributor

Draft PR #26124

Filling in the checklist.

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.59-0 🚀

platform result
🤖 android 🤖 failure ❌
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.60-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 web 🕸 success ✅

@OSBotify
Copy link
Contributor

🚀 Deployed to staging by https://github.com/hayata-suenaga in version: 1.3.60-0 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.59-5 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 failure ❌
🕸 web 🕸 success ✅

@OSBotify
Copy link
Contributor

🚀 Deployed to production by https://github.com/luacmartins in version: 1.3.60-3 🚀

platform result
🤖 android 🤖 success ✅
🖥 desktop 🖥 success ✅
🍎 iOS 🍎 success ✅
🕸 web 🕸 success ✅

const currentWaypoint = lodashGet(transaction, `comment.waypoints.waypoint${waypointIndex}`, {});
const waypointAddress = lodashGet(currentWaypoint, 'address', '');
const totalWaypoints = _.size(lodashGet(transaction, 'comment.waypoints', {}));
// Hide the menu when there is only start and finish waypoint
const shouldShowThreeDotsButton = totalWaypoints > 2;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This caused a regression in #35644 , The delete option should not be displayed for empty waypoints.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants